Vcenter Namespaces Instances ContentLibrarySpec

Vcenter Namespaces Instances ContentLibrarySpec
Vcenter Namespaces Instances ContentLibrarySpec

The Vcenter Namespaces Instances ContentLibrarySpec schema contains the specification required to configure Content Libraries in the VM Image Service.

This schema was added in vSphere API 8.0.2.0.

JSON Example
{
    "content_library": "string",
    "writable": false,
    "allow_import": false,
    "resource_naming_strategy": "string"
}
string
content_library
Required

Content Library ID used by the VM Image Service. The Content Library specified should exist in vSphere inventory.

This property was added in vSphere API 8.0.2.0.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: com.vmware.content.Library. When operations return a value of this schema as a response, the property will be an identifier for the resource type: com.vmware.content.Library.

boolean
writable
Optional

Flag to indicate if the Content Library is writable. When set to true, users with Vcenter Namespaces Access Info.role of type OWNER or EDIT on a Supervisor namespace can add or delete Content Library items in vSphere from this Supervisor namespace. A subscribed Content Library is not allowed to be marked as writable.

An InvalidArgument error will be thrown from POST /vcenter/namespaces/instances operation, PATCH /vcenter/namespaces/instances/{namespace} operation and PUT /vcenter/namespaces/instances/{namespace} operation if a subscribed Content Library has the writable flag set to true.

This property was added in vSphere API 8.0.2.0.

If missing or null, the value defaults to false and the Content Library is read-only to users.

boolean
allow_import
Optional

Flag to indicate if users can import an OVF/OVA template from a remote HTTPS URL into a Content Library that has the writable field set to true. When set to true, users with Vcenter Namespaces Access Info.role of type OWNER or EDIT on a Supervisor namespace can add new Content Library items in vSphere from this Supervisor namespace, by importing OVF/OVA templates from remote HTTPS URLs.

An InvalidArgument error will be thrown from POST /vcenter/namespaces/instances operation, PATCH /vcenter/namespaces/instances/{namespace} operation and PUT /vcenter/namespaces/instances/{namespace} operation if a subscribed Content Library has the allow_import flag set to true or if a Content Library has the allow_import flag set to true but the writable flag is set to false.

This property was added in vSphere API 9.0.0.0.

If missing or null, the value defaults to false and the users will not be able to import an OVF/OVA template from remote HTTPs URLS into the Content Library.

string
resource_naming_strategy
Optional

The resource naming strategy that is used to generate the Kubernetes resource names for images from this Content Library.

An InvalidArgument error will be thrown from POST /vcenter/namespaces/instances operation, PATCH /vcenter/namespaces/instances/{namespace} operation and PUT /vcenter/namespaces/instances/{namespace} operation if this resource_naming_strategy is changed on an existing Content Library associated with the namespace, or set to Vcenter Namespaces Instances ResourceNamingStrategy.PREFER_ITEM_SOURCE_ID on a subscribed Content Library from a published Content Library that is either also associated with the namespace or has another subscribed Content Library associated to the namespace with the resource_naming_strategy also set to Vcenter Namespaces Instances ResourceNamingStrategy.PREFER_ITEM_SOURCE_ID.

For more information see: Vcenter Namespaces Instances ResourceNamingStrategy.

This property was added in vSphere API 9.0.0.0.

If missing or null, Kubernetes resource names for images from this Content Library will be generated based on the default naming strategy Vcenter Namespaces Instances ResourceNamingStrategy.FROM_ITEM_ID.

Property Of